-
Notifications
You must be signed in to change notification settings - Fork 3.2k
Refence docs - __all__.js #1442
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
…es/__all__.js" This reverts commit a9bb0fb.
|
Now that the other PR mentioned has been merged, this can be rebased and the correct changes will be reflected. I think writing documentation with the perspective that it's for developers adding their own property types would be most beneficial. So you can re-use work that you already did to create maybe a markdown document that can be used as a reference. Comments above |
|
Those are good points. I have some questions.
Do you mean that these docs would better live in a readme file than in the code?
Do you mean that the methods are too simplistic to be documented or that the docs should attached to |
These objects all get passed into constructor calls for new PropType objects. The methods on those objects are never called directly except inside PropType, so those particular typings will only ever show up in the editor when someone is working on PropType itself (and only in the constructor if I'm not mistaken). PropType's methods would be a better place for the jsdoc types. The explanation of nuances for individual types could go on a If your curious, RegistrantService is where these entries become actualy PropType instances.
These probably should become description properties like I mention above, but what I meant was re-using the verbs "adapts" or "validates" above methods called |
|
Ohh, I see. That makes perfect sense. What would you recommend? |
|
My recommendation is described by the previous comment. If an specific detail isn't clear feel free to let me know which it is. |
|
Reread your comments. I think I understnad. Will update this PR |
This branch out of onel:reference-docs-20250811_161950/1, so it contains the changes from #1432